<?php ob_start('ob_gzhandler') ?>
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <!--
        /**
        * o------------------------------------------------------------------------------o
        * | This file is part of the RGraph package - you can learn more at:             |
        * |                                                                              |
        * |                          http://www.rgraph.net                               |
        * |                                                                              |
        * | This package is licensed under the RGraph license. For all kinds of business |
        * | purposes there is a small one-time licensing fee to pay and for non          |
        * | commercial  purposes it is free to use. You can read the full license here:  |
        * |                                                                              |
        * |                      http://www.rgraph.net/LICENSE.txt                       |
        * o------------------------------------------------------------------------------o
        */
    -->
    <title>RGraph: HTML5 canvas graph library - meter documentation</title>
    
    <meta name="keywords" content="rgraph html5 canvas docs meter chart" />
    <meta name="description" content="RGraph: HTML5 canvas graph software - Documentation about the Meter chart" />

    <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
    <link rel="icon" type="image/png" href="/favicon.png">
</head>
<body>
    <div id="breadcrumb">
        <a href="../index.html">RGraph: HTML5 canvas graph library</a>
        >
        <a href="index.html">Documentation</a>
        >
        Meter
    </div>

    <h1>RGraph: HTML5 canvas graph library - Meter documentation</h1>

    <script>
        if (RGraph.isIE8()) {
            document.write('<div style="background-color: #fee; border: 2px dashed red; padding: 5px"><b>Important</b><br /><br /> Internet Explorer does not natively support the HTML5 canvas tag yet, so if you want to see the graphs, you can either:<ul><li>Install <a href="http://code.google.com/chrome/chromeframe/">Google Chrome Frame</a></li><li>Use ExCanvas. This is provided in the RGraph Archive.</li><li>Use another browser entirely. Your choices are Firefox 3.5+, Chrome 2+, Safari 4+ or Opera 10.5+. </li></ul></div>');
        }
    </script>

    <p>
        This is the Meter chart. Similar to half the Odometer. The difference is purely visual, but may well be more suited to
        a control panel type application.
    </p>
    
    <p>
        The example file is <a href="../examples/meter.html">here</a>.
    </p>
    
    <pre class="code">
&lt;script&gt;
    window.onload = function ()
    {
        var meter = new RGraph.Meter('myCanvas', 50, 100, 60);
        meter.Set('chart.contextmenu', [
                                        ['Show palette', RGraph.Showpalette],
                                        ['Clear annotations', function () {RGraph.Clear(meter.canvas); meter.Draw();}],
                                        null,
                                        ['Cancel', function () {}]
                                       ]);
        meter.Set('chart.annotatable', true);
        meter.Set('chart.label.position', 'inside');
        meter.Set('chart.title', 'A sample measurement');
        meter.Set('chart.title.vpos', 0.5);
        meter.Set('chart.units.post', 'k');
        meter.Set('chart.red.start', 0);
        meter.Set('chart.red.end', 3);
        meterSet('chart.yellow.start', 3);
        meter.Set('chart.yellow.end', 6);
        meter.Set('chart.green.start', 6);
        meter.Set('chart.green.end', 10);
        meter.Draw();
    }
&lt;/script&gt;
</pre>

    <!-- CONTENTS --><ul><li><a href="#margins">Margins</a></li><li><a href="#colors">Colors</a></li><li><a href="#labels and text">Labels and text</a></li><li><a href="#titles">Titles</a></li><li><a href="#scale">Scale</a></li><li><a href="#interactive features">Interactive features</a></li><li><a href="#shadow">Shadow</a></li><li><a href="#zoom">Zoom</a></li><li><a href="#miscellaneous">Miscellaneous</a></li></ul><!-- /CONTENTS -->

    <!--
        <PROPERTIES>
            heading :: Margins
            chart.gutter :: The gutter of the graph. <br /><i>Default: 25</i>
            
            heading :: Colors
            chart.border.color :: The color of the outline (including tickmarks).<br /><i>Default: black</i>
            chart.green.start :: The value that the green area should begin at. <br /><i>Default: 35% of the maximum value</i>
            chart.green.end :: The value that the green area should end at. <br /><i>Default: The maximum value</i>
            chart.green.color :: The color of the green area, (can be any color).. <br /><i>Default: #207A20</i>
            chart.yellow.start :: The value that the yellow area should begin at. <br /><i>Default: 10% of the maximum value</i>
            chart.yellow.end :: The value that the yellow area should end at. <br /><i>Default: 35% of the maximum value</i>
            chart.green.color :: The color of the yellow area, (can be any color).. <br /><i>Default: #D0AC41</i>
            chart.red.start :: The value that the red area should begin at. <br /><i>Default: The minimum value</i>
            chart.red.end :: The value that the red area should end at. <br /><i>Default: 10% of the maximum value</i>
            chart.red.color :: The color of the red area, (can be any color).. <br /><i>Default: #9E1E1E</i>
            
            heading :: Labels and text
            chart.text.color :: The color of the labels. <br /><i>Default: black</i>
            chart.text.size :: The size (in points) of the labels. <br /><i>Default: 10</i>
            chart.text.font :: The font used to render the text.<br /><i>Default: Verdana</i>
            
            heading :: Titles
            chart.title :: The title of the graph, if any. <br /><i>Default: null</i>
            chart.title.color :: The color of the title.<br /> <i>Default: black</i>
            chart.title.hpos :: This allows you to completely override the horizontal positioning of the title. It should be a number between 0 and 1, and is multiplied with the whole width of the canvas and then used as the horizontal position. <br /><i>Default: null</i>
            chart.title.vpos :: This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i>

            heading :: Scale
            chart.units.pre :: The units that the labels are measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50".<br /><i>Default: none</i>
            chart.units.post :: The units that the labels are measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms".<br /><i>Default: none</i>
            
            
            heading :: Interactive features
            chart.contextmenu :: An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i>
            chart.resizable :: Defaulting to false, this determines whether your graph will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).<br /><i>Default: false</i>
            chart.annotatable :: Whether annotations are enabled for the chart (ie you can draw on the chart interactively).<br /><i>Default: false</i>
            chart.annotate.color :: If you do not allow the use of the palette, then this will be the only color allowed for annotations.<br /><i>Default: black</i>
            
            heading :: Shadow
            chart.shadow :: If true a shadow will be applied to the meter.<br /><i>Default: false</i>
            chart.shadow.color :: The color of the shadow. <br /><i>Default: rgba(0,0,0,0.5)</i>
            chart.shadow.offsetx :: The X offset in pixels for the shadow.<br /><i>Default: 3</i>
            chart.shadow.offsety :: The Y offset in pixels for the shadow.<br /><i>Default: 3</i>
            chart.shadow.blur :: The severity of the shadow blurring effect.<br /><i>Default: 3</i>
            
            heading :: Zoom
            chart.zoom.mode :: Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i>
            chart.zoom.factor :: This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i>
            chart.zoom.fade.in :: Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.fade.out :: Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.hdir :: The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i>
            chart.zoom.vdir :: The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i>
            chart.zoom.delay :: The delay (in milliseconds) between frames.<br /><i>Default: 50</i>
            chart.zoom.frames :: The number of frames in the zoom animation.<br /><i>Default: 10</i>
            chart.zoom.shadow :: Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i>
            chart.zoom.thumbnail.width :: When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.thumbnail.height :: When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.background :: Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i>

            heading :: Miscellaneous
            chart.linewidth :: The width of the outline of the Meter. <br /><i>Default: 2</i>
        </PROPERTIES>
    -->

    <h2>Available properties</h2>
    
    <p>
        You can use these properties to control how the Meter apears. You can set them by using the Set() method. Eg:
    </p>
    
    <p>
        <b>myMeter.Set('name', 'value');</b>
    </p>

    <!-- DOCS -->


<a name="margins"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Margins</h3>            <a name="chart.gutter"></a>
<b>chart.gutter</b><br />
            The gutter of the graph. <br /><i>Default: 25</i><br /><br />
<a name="colors"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Colors</h3>            <a name="chart.border.color"></a>
<b>chart.border.color</b><br />
            The color of the outline (including tickmarks).<br /><i>Default: black</i><br /><br />
            <a name="chart.green.start"></a>
<b>chart.green.start</b><br />
            The value that the green area should begin at. <br /><i>Default: 35% of the maximum value</i><br /><br />
            <a name="chart.green.end"></a>
<b>chart.green.end</b><br />
            The value that the green area should end at. <br /><i>Default: The maximum value</i><br /><br />
            <a name="chart.green.color"></a>
<b>chart.green.color</b><br />
            The color of the green area, (can be any color).. <br /><i>Default: #207A20</i><br /><br />
            <a name="chart.yellow.start"></a>
<b>chart.yellow.start</b><br />
            The value that the yellow area should begin at. <br /><i>Default: 10% of the maximum value</i><br /><br />
            <a name="chart.yellow.end"></a>
<b>chart.yellow.end</b><br />
            The value that the yellow area should end at. <br /><i>Default: 35% of the maximum value</i><br /><br />
            <a name="chart.green.color"></a>
<b>chart.green.color</b><br />
            The color of the yellow area, (can be any color).. <br /><i>Default: #D0AC41</i><br /><br />
            <a name="chart.red.start"></a>
<b>chart.red.start</b><br />
            The value that the red area should begin at. <br /><i>Default: The minimum value</i><br /><br />
            <a name="chart.red.end"></a>
<b>chart.red.end</b><br />
            The value that the red area should end at. <br /><i>Default: 10% of the maximum value</i><br /><br />
            <a name="chart.red.color"></a>
<b>chart.red.color</b><br />
            The color of the red area, (can be any color).. <br /><i>Default: #9E1E1E</i><br /><br />
<a name="labels and text"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Labels and text</h3>            <a name="chart.text.color"></a>
<b>chart.text.color</b><br />
            The color of the labels. <br /><i>Default: black</i><br /><br />
            <a name="chart.text.size"></a>
<b>chart.text.size</b><br />
            The size (in points) of the labels. <br /><i>Default: 10</i><br /><br />
            <a name="chart.text.font"></a>
<b>chart.text.font</b><br />
            The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
<a name="titles"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Titles</h3>            <a name="chart.title"></a>
<b>chart.title</b><br />
            The title of the graph, if any. <br /><i>Default: null</i><br /><br />
            <a name="chart.title.color"></a>
<b>chart.title.color</b><br />
            The color of the title.<br /> <i>Default: black</i><br /><br />
            <a name="chart.title.hpos"></a>
<b>chart.title.hpos</b><br />
            This allows you to completely override the horizontal positioning of the title. It should be a number between 0 and 1, and is multiplied with the whole width of the canvas and then used as the horizontal position. <br /><i>Default: null</i><br /><br />
            <a name="chart.title.vpos"></a>
<b>chart.title.vpos</b><br />
            This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i><br /><br />
<a name="scale"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Scale</h3>            <a name="chart.units.pre"></a>
<b>chart.units.pre</b><br />
            The units that the labels are measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50".<br /><i>Default: none</i><br /><br />
            <a name="chart.units.post"></a>
<b>chart.units.post</b><br />
            The units that the labels are measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms".<br /><i>Default: none</i><br /><br />
<a name="interactive features"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Interactive features</h3>            <a name="chart.contextmenu"></a>
<b>chart.contextmenu</b><br />
            An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i><br /><br />
            <a name="chart.resizable"></a>
<b>chart.resizable</b><br />
            Defaulting to false, this determines whether your graph will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).<br /><i>Default: false</i><br /><br />
            <a name="chart.annotatable"></a>
<b>chart.annotatable</b><br />
            Whether annotations are enabled for the chart (ie you can draw on the chart interactively).<br /><i>Default: false</i><br /><br />
            <a name="chart.annotate.color"></a>
<b>chart.annotate.color</b><br />
            If you do not allow the use of the palette, then this will be the only color allowed for annotations.<br /><i>Default: black</i><br /><br />
<a name="shadow"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Shadow</h3>            <a name="chart.shadow"></a>
<b>chart.shadow</b><br />
            If true a shadow will be applied to the meter.<br /><i>Default: false</i><br /><br />
            <a name="chart.shadow.color"></a>
<b>chart.shadow.color</b><br />
            The color of the shadow. <br /><i>Default: rgba(0,0,0,0.5)</i><br /><br />
            <a name="chart.shadow.offsetx"></a>
<b>chart.shadow.offsetx</b><br />
            The X offset in pixels for the shadow.<br /><i>Default: 3</i><br /><br />
            <a name="chart.shadow.offsety"></a>
<b>chart.shadow.offsety</b><br />
            The Y offset in pixels for the shadow.<br /><i>Default: 3</i><br /><br />
            <a name="chart.shadow.blur"></a>
<b>chart.shadow.blur</b><br />
            The severity of the shadow blurring effect.<br /><i>Default: 3</i><br /><br />
<a name="zoom"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Zoom</h3>            <a name="chart.zoom.mode"></a>
<b>chart.zoom.mode</b><br />
            Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i><br /><br />
            <a name="chart.zoom.factor"></a>
<b>chart.zoom.factor</b><br />
            This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i><br /><br />
            <a name="chart.zoom.fade.in"></a>
<b>chart.zoom.fade.in</b><br />
            Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i><br /><br />
            <a name="chart.zoom.fade.out"></a>
<b>chart.zoom.fade.out</b><br />
            Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i><br /><br />
            <a name="chart.zoom.hdir"></a>
<b>chart.zoom.hdir</b><br />
            The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i><br /><br />
            <a name="chart.zoom.vdir"></a>
<b>chart.zoom.vdir</b><br />
            The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i><br /><br />
            <a name="chart.zoom.delay"></a>
<b>chart.zoom.delay</b><br />
            The delay (in milliseconds) between frames.<br /><i>Default: 50</i><br /><br />
            <a name="chart.zoom.frames"></a>
<b>chart.zoom.frames</b><br />
            The number of frames in the zoom animation.<br /><i>Default: 10</i><br /><br />
            <a name="chart.zoom.shadow"></a>
<b>chart.zoom.shadow</b><br />
            Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i><br /><br />
            <a name="chart.zoom.thumbnail.width"></a>
<b>chart.zoom.thumbnail.width</b><br />
            When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
            <a name="chart.zoom.thumbnail.height"></a>
<b>chart.zoom.thumbnail.height</b><br />
            When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
            <a name="chart.zoom.background"></a>
<b>chart.zoom.background</b><br />
            Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i><br /><br />
<a name="miscellaneous"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Miscellaneous</h3>            <a name="chart.linewidth"></a>
<b>chart.linewidth</b><br />
            The width of the outline of the Meter. <br /><i>Default: 2</i><br /><br />
</div><!-- /DOCS --><br /><br />
</body>
</html>